Investigator API
POST Search TaxMatrix By PGPI
Overview
Performs a pgpi operation.
OperationId: POST Search TaxMatrix By PGPI
Authorization Method(s): OAuth
Verb: POST
End Point: /api/taxmatrix/search/pgpi
Example Request
The following is an json request for this operation.
{
"filters": {
"customerUsageType": "07",
"providerType": "80",
"asOfDate": {
"year": "2024",
"month": "12",
"day": 1
},
"releaseNumber": null,
"dateType": "Date"
},
"parameters": {
"pgpis": [
{
"productGroup": "1111",
"productItem": "55"
}
],
"postalCode": null,
"npanxx": null,
"locations": null,
"address": null,
"stateCountyCity": null,
"geocode": "US48113A0004",
"by": "ProductGroupItem",
"skus": []
},
"clientNumber": "ZRERT1234",
"searchCountry": "UnitedStates",
"searchOption": "PostalCode",
"searchType": "TaxabilityMatrix"
}Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Api-version* | api-version | undefined |
Overview
Example Response
The following is an example response you can expect for this operation
{
"pgpiResult": [
{
"productGroups": [
{
"group": "0111",
"groupDescription": "ALCOHOLIC BEVERAGES-GROCERY",
"items": [
{
"item": "006",
"itemDescription": "READY TO DRINK COCKTAILS"
}
]
}
]
}
]
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | Returns the result of the pgpi operation. |
| 400 | Invalid request to call the API. |
| 401 | User is not authorized to access the API. |